docs: restore curl Quick install; add clickhousectl install page#125
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: restore curl Quick install; add clickhousectl install page#125mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ports ClickHouse/clickhouse-docs#6343 to the Mintlify docs: restores the curl-based Quick install flow and adds a dedicated clickhousectl install page so both local-development methods are documented side by side.
Changes
snippets/_quick_install.mdx— restored the curl flow (single binary), added theCLICKHOUSE_ONLY=1note, fixed a typo (comand), and dropped the~/.local/binPATH detail per upstream.core/get-started/setup/self-managed/install-curl.mdx(new) — new page at slug/install/quick-installthat renders the_quick_installsnippet.core/get-started/setup/self-managed/clickhousectl.mdx(new) — new page at slug/install/clickhousectlthat renders the_cli_installsnippet, with a Windows/WSL note.core/get-started/setup/install.mdx— Quick install card now points at/install/quick-installand a new clickhousectl (CLI) card was added.products/cloud/features/cli.mdx— Local development link repointed to/install/clickhousectl.core/get-started/navigation.json— added the two new pages under the Self-managed group.Context
src/pages/index.mdxhomepage button rename (ClickHouse CLI → ClickHouse Client) does not apply: the Mintlify homepage (index.mdx) doesn't expose that button.Ambiguities / notes for review
core/get-started/setup/self-managed/quick-install.mdxhas slug/getting-started/quick-start/oss— it actually mirrors Docusaurusgetting-started/quick-start/oss.mdx, notinstall/quick-install.md. The filename is misleading but pre-existing. To avoid a filename collision, the new curl page was created asinstall-curl.mdx._cli_install.mdxsnippet was not changed in upstream PR #6343 and is intentionally left untouched, even though its content has drifted from the upstream snippet in prior work.Note
Low Risk
Documentation-only routing and content changes with no runtime or security impact.
Overview
Restores curl-based quick install as its own doc at
/install/quick-installand adds a parallelclickhousectlinstall page at/install/clickhousectl, so local setup is documented as two first-class paths instead of folding everything into one route.The Install hub gains a clickhousectl (CLI) card and points Quick install at
/install/quick-install. Self-managed nav lists both new pages._quick_install.mdxnow documents that the curl script also installsclickhousectl(andchctl), addsCLICKHOUSE_ONLY=1to skip the CLI, and fixes a typo. Cloud CLI local-development copy links to/install/clickhousectl.Reviewed by Cursor Bugbot for commit 2458801. Bugbot is set up for automated code reviews on this repo. Configure here.